Skip to content

REST API: Log doing_it_wrong notices to debug.log#10537

Open
ilclaudio wants to merge 2 commits intoWordPress:trunkfrom
ilclaudio:fix/64260-rest-doing-it-wrong-log
Open

REST API: Log doing_it_wrong notices to debug.log#10537
ilclaudio wants to merge 2 commits intoWordPress:trunkfrom
ilclaudio:fix/64260-rest-doing-it-wrong-log

Conversation

@ilclaudio
Copy link

Fixes #64260. The doing_it_wrong_trigger_error filter was preventing all doing_it_wrong notices from being logged during REST requests. This change ensures notices are written to debug.log while still preventing trigger_error() from interfering with REST responses.

Now the error is filterd but in the debug.log file you can see a meeesage like this:

[21-Nov-2025 14:01:41 UTC] REST API - Doing it wrong: register_rest_route - The REST API route definition for test/v1/example is missing the required permission_callback argument. For REST API routes that are intended to be public, use __return_true as the permission callback. (This message was added in version 5.5.0.)

Trac ticket: https://core.trac.wordpress.org/ticket/64260

Fixes #64260. The doing_it_wrong_trigger_error filter was preventing
all doing_it_wrong notices from being logged during REST requests.
This change ensures notices are written to debug.log while still
preventing trigger_error() from interfering with REST responses.
@github-actions
Copy link

Hi @ilclaudio! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

@github-actions
Copy link

github-actions bot commented Nov 21, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @claudiobat.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

Core Committers: Use this line as a base for the props when committing in SVN:

Props westonruter, ioclaudio, juanmaguitar.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Fixes #64260. The doing_it_wrong_trigger_error filter was preventing
all doing_it_wrong notices from being logged during REST requests.
This change ensures notices are written to debug.log while still
preventing trigger_error() from interfering with REST responses.
@ilclaudio
Copy link
Author

It looks like one of the GitHub Actions jobs failed due to a transient network issue (curl error 7 while downloading from packagist.org) and not because of my code changes.
Could someone please re-run the failed job? Thank you!

Comment on lines +288 to +289
// Prevent PHP's trigger_error() to avoid corrupting JSON responses.
return false;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will it, though? During REST API responses, the PHP display_errors config option is set to 0:

/*
* The 'REST_REQUEST' check here is optimistic as the constant is most
* likely not set at this point even if it is in fact a REST request.
*/
if ( defined( 'XMLRPC_REQUEST' ) || defined( 'REST_REQUEST' ) || defined( 'MS_FILES_REQUEST' )
|| ( defined( 'WP_INSTALLING' ) && WP_INSTALLING )
|| wp_doing_ajax() || wp_is_json_request()
) {
ini_set( 'display_errors', 0 );
}

Therefore, why not just remove the doing_it_wrong_trigger_error filter altogether?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the insight! You're right.
Since wp_debug_mode() already sets display_errors = 0 for REST requests, trigger_error() won't corrupt the response.
I'll simplify the fix by removing the doing_it_wrong_trigger_error filter altogether.
I'll try to push an update shortly.

Copy link

@claudiobat claudiobat Feb 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the insight! You're right. Since wp_debug_mode() already sets display_errors = 0 for REST requests, trigger_error() won't corrupt the response. I'll simplify the fix by removing the doing_it_wrong_trigger_error filter altogether. I'll try to push an update shortly.

I tested your suggestion and it works, but the resulting log entries contain raw HTML markup which makes the log harder to read and produces a stacktrace.
My original approach produces a cleaner output.
Should we keep the manual error_log() call to sanitize the message, or is there another approach you'd suggest?
However I'll try to debug better the problem.

@westonruter
Copy link
Member

Could someone please re-run the failed job? Thank you!

Re-run!

@juanmaguitar
Copy link

@ilclaudio There's some feedback provided in this PR.
Do you think you'll have time to address it in time for WP 7.0?

@ilclaudio
Copy link
Author

Hi @juanmaguitar I have only proposed a patch but I'm not responsible to include it into the official code. I honestly don't know what else to do.

@juanmaguitar
Copy link

juanmaguitar commented Feb 27, 2026

@ilclaudio, first of all thank for proposing this patch for the ticket :)

There's some feedback on the PR provided by @westonruter that still needs to be addressed

why not just remove the doing_it_wrong_trigger_error filter altogether?

A response to that comment would be helpful to move forward with this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants